docs: update README security claims and CLI options - #34
Merged
Conversation
…EADME Signed-off-by: danbugs <danilochiarlone@gmail.com>
Signed-off-by: danbugs <danilochiarlone@gmail.com>
There was a problem hiding this comment.
Pull request overview
Updates the README to (1) replace an inaccurate "No host function calls" feature claim with a more honest description of the opt-in host surface and __dispatch bridge, and (2) bring the documented CLI options block in line with the actual Args struct in host/src/main.rs.
Changes:
- Reword the security/feature bullet to clarify that the guest has no host access by default but opts in via flags like
--mount,--net,--enable-tools, with a pointer toHOST_FUNCTIONS.md. - Expand the CLI options block from 5 to 14 flags, matching the current
Argsstruct (including--enable-tools,--mount,--net,--net-allow,--net-block,--port,--repeat,-e/--exec).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Linux Benchmarks
Details
| Benchmark suite | Current: a96e453 | Previous: 79b32ae | Ratio |
|---|---|---|---|
hello_world (median) |
20 ms |
20 ms |
1 |
pandas (median) |
100 ms |
100 ms |
1 |
density (per VM) |
7 MB |
7 MB |
1 |
snapshot (disk) |
385 MiB |
385 MiB |
1 |
This comment was automatically generated by workflow using github-action-benchmark.
Contributor
There was a problem hiding this comment.
Windows Benchmarks
Details
| Benchmark suite | Current: a96e453 | Previous: 79b32ae | Ratio |
|---|---|---|---|
hello_world (median) |
242 ms |
234 ms |
1.03 |
pandas (median) |
785 ms |
708 ms |
1.11 |
density (per VM) |
6 MB |
6 MB |
1 |
snapshot (disk) |
393 MiB |
393 MiB |
1 |
This comment was automatically generated by workflow using github-action-benchmark.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
__dispatchexists) with "Thin, opt-in host surface" — clarifies that theguest has no host access by default, and features are explicitly enabled via
--mount,--net, etc. Links to HOST_FUNCTIONS.md for the full list.the actual Args struct in main.rs.
Test plan
host/src/main.rsArgs struct